<!DOCTYPE html>
<html lang="en-US">
<head>
    <meta charset="UTF-8"/>
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <meta name="language" content="en" />
        <link href="./assets/ffd55088/css/bootstrap.css" rel="stylesheet">
<link href="./assets/5cf9384a/solarized_light.css" rel="stylesheet">
<link href="./assets/6c54116e/style.css" rel="stylesheet">
<script src="./assets/a44cef0f/jquery.js"></script>
<script src="./assets/ffd55088/js/bootstrap.js"></script>
<script src="./assets/8ac4e28a/jssearch.js"></script>    <title>YiiRequirementChecker, YiiRequirementChecker - Yii Framework 2.0 API Documentation</title>
</head>
<body>

<div class="wrap">
    <nav id="w10541" class="navbar-inverse navbar-fixed-top navbar" role="navigation"><div class="navbar-header"><button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#w10541-collapse"><span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span></button><a class="navbar-brand" href="./index.html">Yii Framework 2.0 API Documentation</a></div><div id="w10541-collapse" class="collapse navbar-collapse"><ul id="w10542" class="navbar-nav nav"><li><a href="./index.html">Class reference</a></li>
<li class="dropdown"><a class="dropdown-toggle" href="#" data-toggle="dropdown">Extensions <b class="caret"></b></a><ul id="w10543" class="dropdown-menu"><li><a href="./ext-apidoc-index.html" tabindex="-1">apidoc</a></li>
<li><a href="./ext-authclient-index.html" tabindex="-1">authclient</a></li>
<li><a href="./ext-bootstrap-index.html" tabindex="-1">bootstrap</a></li>
<li><a href="./ext-codeception-index.html" tabindex="-1">codeception</a></li>
<li><a href="./ext-debug-index.html" tabindex="-1">debug</a></li>
<li><a href="./ext-elasticsearch-index.html" tabindex="-1">elasticsearch</a></li>
<li><a href="./ext-faker-index.html" tabindex="-1">faker</a></li>
<li><a href="./ext-gii-index.html" tabindex="-1">gii</a></li>
<li><a href="./ext-imagine-index.html" tabindex="-1">imagine</a></li>
<li><a href="./ext-jui-index.html" tabindex="-1">jui</a></li>
<li><a href="./ext-mongodb-index.html" tabindex="-1">mongodb</a></li>
<li><a href="./ext-redis-index.html" tabindex="-1">redis</a></li>
<li><a href="./ext-smarty-index.html" tabindex="-1">smarty</a></li>
<li><a href="./ext-sphinx-index.html" tabindex="-1">sphinx</a></li>
<li><a href="./ext-swiftmailer-index.html" tabindex="-1">swiftmailer</a></li>
<li><a href="./ext-twig-index.html" tabindex="-1">twig</a></li></ul></li>
<li><a href="./guide-README.html">Guide</a></li></ul><div class="navbar-form navbar-left" role="search">
  <div class="form-group">
    <input id="searchbox" type="text" class="form-control" placeholder="Search">
  </div>
</div>
</div></nav>
    <div id="search-resultbox" style="display: none;" class="modal-content">
        <ul id="search-results">
        </ul>
    </div>

    
<div class="row">
    <div class="col-md-3">
                <div id="navigation" class="list-group"><a class="list-group-item active" href="#navigation-10540" data-toggle="collapse" data-parent="#navigation">Not namespaced classes <b class="caret"></b></a><div id="navigation-10540" class="submenu panel-collapse collapse in"><a class="list-group-item" href="./yii.html">Yii</a>
<a class="list-group-item active" href="./yiirequirementchecker.html">YiiRequirementChecker</a></div></div>    </div>
    <div class="col-md-9 api-content" role="main">
        <h1>Class YiiRequirementChecker</h1>
<div class="top-nav">
    <a href="index.html">All Classes</a>
                | <a href="#methods">Methods</a>
            </div>

<table class="summaryTable docClass table table-bordered">
    <colgroup>
        <col class="col-name" />
        <col class="col-value" />
    </colgroup>
            <tr><th>Inheritance</th><td><a href="yiirequirementchecker.html">YiiRequirementChecker</a></td></tr>
                                        <tr><th>Available since version</th><td>2.0</td></tr>
            </table>

<div class="class-description">
    <p><strong>YiiRequirementChecker allows checking, if current system meets the requirements for running the Yii application.</strong></p>
    <p>This class allows rendering of the check report for the web and console application interface.</p>
<p>Example:</p>
<pre><code class="hljs php language-php"><span class="hljs-keyword">require_once</span>(<span class="hljs-string">'path/to/YiiRequirementChecker.php'</span>);
<span class="hljs-variable">$requirementsChecker</span> = <span class="hljs-keyword">new</span> YiiRequirementChecker();
<span class="hljs-variable">$requirements</span> = <span class="hljs-keyword">array</span>(
    <span class="hljs-keyword">array</span>(
        <span class="hljs-string">'name'</span> =&gt; <span class="hljs-string">'PHP Some Extension'</span>,
        <span class="hljs-string">'mandatory'</span> =&gt; <span class="hljs-keyword">true</span>,
        <span class="hljs-string">'condition'</span> =&gt; extension_loaded(<span class="hljs-string">'some_extension'</span>),
        <span class="hljs-string">'by'</span> =&gt; <span class="hljs-string">'Some application feature'</span>,
        <span class="hljs-string">'memo'</span> =&gt; <span class="hljs-string">'PHP extension "some_extension" required'</span>,
    ),
);
<span class="hljs-variable">$requirementsChecker</span>-&gt;checkYii()-&gt;check(<span class="hljs-variable">$requirements</span>)-&gt;render();
</code></pre>
<p>If you wish to render the report with your own representation, use <a href="yiirequirementchecker.html#getResult()-detail">getResult()</a> instead of <a href="yiirequirementchecker.html#render()-detail">render()</a></p>
<p>Requirement condition could be in format "eval:PHP expression".
In this case specified PHP expression will be evaluated in the context of this class instance.
For example:</p>
<pre><code class="hljs php language-php"><span class="hljs-variable">$requirements</span> = <span class="hljs-keyword">array</span>(
    <span class="hljs-keyword">array</span>(
        <span class="hljs-string">'name'</span> =&gt; <span class="hljs-string">'Upload max file size'</span>,
        <span class="hljs-string">'condition'</span> =&gt; <span class="hljs-string">'eval:$this-&gt;checkUploadMaxFileSize("5M")'</span>,
    ),
);
</code></pre>
<p>Note: this class definition does not match ordinary Yii style, because it should match PHP 4.3
and should not use features from newer PHP versions!</p>

    </div>

<a id="properties"></a>

<a id="methods"></a>

<div class="summary doc-method">
<h2>Public Methods</h2>

<p><a href="#" class="toggle">Hide inherited methods</a></p>

<table class="summary-table table table-striped table-bordered table-hover">
<colgroup>
    <col class="col-method" />
    <col class="col-description" />
    <col class="col-defined" />
</colgroup>
<tr>
  <th>Method</th><th>Description</th><th>Defined By</th>
</tr>
        <tr id="check()">
        <td><a href="yiirequirementchecker.html#check()-detail">check()</a></td>
        <td>Check the given requirements, collecting results into internal field.</td>
        <td><a href="yiirequirementchecker.html">YiiRequirementChecker</a></td>
    </tr>
            <tr id="checkPhpExtensionVersion()">
        <td><a href="yiirequirementchecker.html#checkPhpExtensionVersion()-detail">checkPhpExtensionVersion()</a></td>
        <td>Checks if the given PHP extension is available and its version matches the given one.</td>
        <td><a href="yiirequirementchecker.html">YiiRequirementChecker</a></td>
    </tr>
            <tr id="checkPhpIniOff()">
        <td><a href="yiirequirementchecker.html#checkPhpIniOff()-detail">checkPhpIniOff()</a></td>
        <td>Checks if PHP configuration option (from php.ini) is off.</td>
        <td><a href="yiirequirementchecker.html">YiiRequirementChecker</a></td>
    </tr>
            <tr id="checkPhpIniOn()">
        <td><a href="yiirequirementchecker.html#checkPhpIniOn()-detail">checkPhpIniOn()</a></td>
        <td>Checks if PHP configuration option (from php.ini) is on.</td>
        <td><a href="yiirequirementchecker.html">YiiRequirementChecker</a></td>
    </tr>
            <tr id="checkUploadMaxFileSize()">
        <td><a href="yiirequirementchecker.html#checkUploadMaxFileSize()-detail">checkUploadMaxFileSize()</a></td>
        <td>Checks if upload max file size matches the given range.</td>
        <td><a href="yiirequirementchecker.html">YiiRequirementChecker</a></td>
    </tr>
            <tr id="checkYii()">
        <td><a href="yiirequirementchecker.html#checkYii()-detail">checkYii()</a></td>
        <td>Performs the check for the Yii core requirements.</td>
        <td><a href="yiirequirementchecker.html">YiiRequirementChecker</a></td>
    </tr>
            <tr id="compareByteSize()">
        <td><a href="yiirequirementchecker.html#compareByteSize()-detail">compareByteSize()</a></td>
        <td>Compare byte sizes of values given in the verbose representation,
like '5M', '15K' etc.</td>
        <td><a href="yiirequirementchecker.html">YiiRequirementChecker</a></td>
    </tr>
            <tr id="evaluateExpression()">
        <td><a href="yiirequirementchecker.html#evaluateExpression()-detail">evaluateExpression()</a></td>
        <td>Evaluates a PHP expression under the context of this class.</td>
        <td><a href="yiirequirementchecker.html">YiiRequirementChecker</a></td>
    </tr>
            <tr id="getByteSize()">
        <td><a href="yiirequirementchecker.html#getByteSize()-detail">getByteSize()</a></td>
        <td>Gets the size in bytes from verbose size representation.</td>
        <td><a href="yiirequirementchecker.html">YiiRequirementChecker</a></td>
    </tr>
            <tr id="getNowDate()">
        <td><a href="yiirequirementchecker.html#getNowDate()-detail">getNowDate()</a></td>
        <td>Returns the now date if possible in string representation.</td>
        <td><a href="yiirequirementchecker.html">YiiRequirementChecker</a></td>
    </tr>
            <tr id="getResult()">
        <td><a href="yiirequirementchecker.html#getResult()-detail">getResult()</a></td>
        <td>Return the check results.</td>
        <td><a href="yiirequirementchecker.html">YiiRequirementChecker</a></td>
    </tr>
            <tr id="getServerInfo()">
        <td><a href="yiirequirementchecker.html#getServerInfo()-detail">getServerInfo()</a></td>
        <td>Returns the server information.</td>
        <td><a href="yiirequirementchecker.html">YiiRequirementChecker</a></td>
    </tr>
            <tr id="normalizeRequirement()">
        <td><a href="yiirequirementchecker.html#normalizeRequirement()-detail">normalizeRequirement()</a></td>
        <td>Normalizes requirement ensuring it has correct format.</td>
        <td><a href="yiirequirementchecker.html">YiiRequirementChecker</a></td>
    </tr>
            <tr id="render()">
        <td><a href="yiirequirementchecker.html#render()-detail">render()</a></td>
        <td>Renders the requirements check result.</td>
        <td><a href="yiirequirementchecker.html">YiiRequirementChecker</a></td>
    </tr>
            <tr id="renderViewFile()">
        <td><a href="yiirequirementchecker.html#renderViewFile()-detail">renderViewFile()</a></td>
        <td>Renders a view file.</td>
        <td><a href="yiirequirementchecker.html">YiiRequirementChecker</a></td>
    </tr>
            <tr id="usageError()">
        <td><a href="yiirequirementchecker.html#usageError()-detail">usageError()</a></td>
        <td>Displays a usage error.</td>
        <td><a href="yiirequirementchecker.html">YiiRequirementChecker</a></td>
    </tr>
    </table>
</div>

<a id="events"></a>

<a id="constants"></a>

<h2>Method Details</h2>

<div class="method-doc">

    <div class="detail-header h3" id="check()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yiirequirementchecker.html#check()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
        
        check()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Check the given requirements, collecting results into internal field.</strong></p>

        <p>This method can be invoked several times checking different requirement sets.
Use <a href="yiirequirementchecker.html#getResult()-detail">getResult()</a> or <a href="yiirequirementchecker.html#render()-detail">render()</a> to get the results.</p>

            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yiirequirementchecker.html">$this</a></span> <strong><a href="yiirequirementchecker.html#check()-detail">check</a></strong> ( <span style="color: #0000BB">$requirements</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$requirements</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a>|<a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>Requirements to be checked.
If an array, it is treated as the set of requirements;
If a string, it is treated as the path of the file, which contains the requirements;</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="yiirequirementchecker.html">$this</a></td>
                  <td class="param-desc-col"><p>Self instance.</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="checkPhpExtensionVersion()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yiirequirementchecker.html#checkPhpExtensionVersion()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
        
        checkPhpExtensionVersion()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Checks if the given PHP extension is available and its version matches the given one.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.boolean">boolean</a></span> <strong><a href="yiirequirementchecker.html#checkPhpExtensionVersion()-detail">checkPhpExtensionVersion</a></strong> ( <span style="color: #0000BB">$extensionName</span>, <span style="color: #0000BB">$version</span>, <span style="color: #0000BB">$compare&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #DD0000">'&gt;='</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$extensionName</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>PHP extension name.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$version</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>Required PHP extension version.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$compare</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>Comparison operator, by default '&gt;='</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.boolean">boolean</a></td>
                  <td class="param-desc-col"><p>If PHP extension version matches.</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="checkPhpIniOff()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yiirequirementchecker.html#checkPhpIniOff()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
        
        checkPhpIniOff()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Checks if PHP configuration option (from php.ini) is off.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.boolean">boolean</a></span> <strong><a href="yiirequirementchecker.html#checkPhpIniOff()-detail">checkPhpIniOff</a></strong> ( <span style="color: #0000BB">$name</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$name</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>Configuration option name.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.boolean">boolean</a></td>
                  <td class="param-desc-col"><p>Option is off.</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="checkPhpIniOn()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yiirequirementchecker.html#checkPhpIniOn()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
        
        checkPhpIniOn()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Checks if PHP configuration option (from php.ini) is on.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.boolean">boolean</a></span> <strong><a href="yiirequirementchecker.html#checkPhpIniOn()-detail">checkPhpIniOn</a></strong> ( <span style="color: #0000BB">$name</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$name</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>Configuration option name.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.boolean">boolean</a></td>
                  <td class="param-desc-col"><p>Option is on.</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="checkUploadMaxFileSize()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yiirequirementchecker.html#checkUploadMaxFileSize()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
        
        checkUploadMaxFileSize()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Checks if upload max file size matches the given range.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.boolean">boolean</a></span> <strong><a href="yiirequirementchecker.html#checkUploadMaxFileSize()-detail">checkUploadMaxFileSize</a></strong> ( <span style="color: #0000BB">$min&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">null</span>, <span style="color: #0000BB">$max&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">null</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$min</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a>|<a href="http://www.php.net/language.types.null">null</a></td>
                  <td class="param-desc-col"><p>Verbose file size minimum required value, pass null to skip minimum check.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$max</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a>|<a href="http://www.php.net/language.types.null">null</a></td>
                  <td class="param-desc-col"><p>Verbose file size maximum required value, pass null to skip maximum check.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.boolean">boolean</a></td>
                  <td class="param-desc-col"><p>Success.</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="checkYii()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yiirequirementchecker.html#checkYii()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
        
        checkYii()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Performs the check for the Yii core requirements.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yiirequirementchecker.html">YiiRequirementChecker</a></span> <strong><a href="yiirequirementchecker.html#checkYii()-detail">checkYii</a></strong> ( )</td></tr>
                                                <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="yiirequirementchecker.html">YiiRequirementChecker</a></td>
                  <td class="param-desc-col"><p>Self instance.</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="compareByteSize()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yiirequirementchecker.html#compareByteSize()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
        
        compareByteSize()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Compare byte sizes of values given in the verbose representation,
like '5M', '15K' etc.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.boolean">boolean</a></span> <strong><a href="yiirequirementchecker.html#compareByteSize()-detail">compareByteSize</a></strong> ( <span style="color: #0000BB">$a</span>, <span style="color: #0000BB">$b</span>, <span style="color: #0000BB">$compare&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #DD0000">'&gt;='</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$a</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>First value.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$b</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>Second value.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$compare</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>Comparison operator, by default '&gt;='.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.boolean">boolean</a></td>
                  <td class="param-desc-col"><p>Comparison result.</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="evaluateExpression()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yiirequirementchecker.html#evaluateExpression()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
        
        evaluateExpression()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Evaluates a PHP expression under the context of this class.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type">mixed</span> <strong><a href="yiirequirementchecker.html#evaluateExpression()-detail">evaluateExpression</a></strong> ( <span style="color: #0000BB">$expression</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$expression</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>A PHP expression to be evaluated.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col">mixed</td>
                  <td class="param-desc-col"><p>The expression result.</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="getByteSize()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yiirequirementchecker.html#getByteSize()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
        
        getByteSize()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Gets the size in bytes from verbose size representation.</strong></p>

        <p>For example: '5K' =&gt; 5*1024</p>

            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.integer">integer</a></span> <strong><a href="yiirequirementchecker.html#getByteSize()-detail">getByteSize</a></strong> ( <span style="color: #0000BB">$verboseSize</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$verboseSize</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>Verbose size representation.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.integer">integer</a></td>
                  <td class="param-desc-col"><p>Actual size in bytes.</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="getNowDate()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yiirequirementchecker.html#getNowDate()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
        
        getNowDate()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Returns the now date if possible in string representation.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yiirequirementchecker.html#getNowDate()-detail">getNowDate</a></strong> ( )</td></tr>
                                                <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>Now date.</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="getResult()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yiirequirementchecker.html#getResult()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
        
        getResult()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Return the check results.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.array">array</a>|<a href="http://www.php.net/language.types.null">null</a></span> <strong><a href="yiirequirementchecker.html#getResult()-detail">getResult</a></strong> ( )</td></tr>
                                                <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a>|<a href="http://www.php.net/language.types.null">null</a></td>
                  <td class="param-desc-col"><p>Check results in format:</p>
<pre><code class="hljs php language-php"><span class="hljs-keyword">array</span>(
    <span class="hljs-string">'summary'</span> =&gt; <span class="hljs-keyword">array</span>(
        <span class="hljs-string">'total'</span> =&gt; total number of checks,
        <span class="hljs-string">'errors'</span> =&gt; number of errors,
        <span class="hljs-string">'warnings'</span> =&gt; number of warnings,
    ),
    <span class="hljs-string">'requirements'</span> =&gt; <span class="hljs-keyword">array</span>(
        <span class="hljs-keyword">array</span>(
            ...
            <span class="hljs-string">'error'</span> =&gt; is there an error,
            <span class="hljs-string">'warning'</span> =&gt; is there a warning,
        ),
        ...
    ),
)
</code></pre>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="getServerInfo()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yiirequirementchecker.html#getServerInfo()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
        
        getServerInfo()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Returns the server information.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yiirequirementchecker.html#getServerInfo()-detail">getServerInfo</a></strong> ( )</td></tr>
                                                <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>Server information.</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="normalizeRequirement()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yiirequirementchecker.html#normalizeRequirement()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
        
        normalizeRequirement()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Normalizes requirement ensuring it has correct format.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.array">array</a></span> <strong><a href="yiirequirementchecker.html#normalizeRequirement()-detail">normalizeRequirement</a></strong> ( <span style="color: #0000BB">$requirement</span>, <span style="color: #0000BB">$requirementKey&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">0</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$requirement</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>Raw requirement.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$requirementKey</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.integer">integer</a></td>
                  <td class="param-desc-col"><p>Requirement key in the list.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>Normalized requirement.</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="render()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yiirequirementchecker.html#render()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
        
        render()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Renders the requirements check result.</strong></p>

        <p>The output will vary depending is a script running from web or from console.</p>

            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type">void</span> <strong><a href="yiirequirementchecker.html#render()-detail">render</a></strong> ( )</td></tr>
            </table>

<!--	-->

    <div class="detail-header h3" id="renderViewFile()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yiirequirementchecker.html#renderViewFile()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
        
        renderViewFile()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Renders a view file.</strong></p>

        <p>This method includes the view file as a PHP script
and captures the display result if required.</p>

            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yiirequirementchecker.html#renderViewFile()-detail">renderViewFile</a></strong> ( <span style="color: #0000BB">$_viewFile_</span>, <span style="color: #0000BB">$_data_&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">null</span>, <span style="color: #0000BB">$_return_&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">false</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$_viewFile_</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>View file</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$_data_</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>Data to be extracted and made available to the view file</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$_return_</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.boolean">boolean</a></td>
                  <td class="param-desc-col"><p>Whether the rendering result should be returned as a string</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The rendering result. Null if the rendering result is not required.</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="usageError()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yiirequirementchecker.html#usageError()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
        
        usageError()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Displays a usage error.</strong></p>

        <p>This method will then terminate the execution of the current application.</p>

            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type">void</span> <strong><a href="yiirequirementchecker.html#usageError()-detail">usageError</a></strong> ( <span style="color: #0000BB">$message</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$message</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The error message</p>
</td>
                </tr>
                                                </table>

<!--	-->
</div>
        </div>
</div>

<script type="text/javascript">
    /*<![CDATA[*/
    $("a.toggle").on('click', function () {
        var $this = $(this);
        if ($this.hasClass('properties-hidden')) {
            $this.text($this.text().replace(/Show/,'Hide'));
            $this.parents(".summary").find(".inherited").show();
            $this.removeClass('properties-hidden');
        } else {
            $this.text($this.text().replace(/Hide/,'Show'));
            $this.parents(".summary").find(".inherited").hide();
            $this.addClass('properties-hidden');
        }

        return false;
    });
    /*
     $(".sourceCode a.show").toggle(function () {
     $(this).text($(this).text().replace(/show/,'hide'));
     $(this).parents(".sourceCode").find("div.code").show();
     },function () {
     $(this).text($(this).text().replace(/hide/,'show'));
     $(this).parents(".sourceCode").find("div.code").hide();
     });
     $("a.sourceLink").click(function () {
     $(this).attr('target','_blank');
     });
     */
    /*]]>*/
</script>


</div>

<footer class="footer">
        <p class="pull-right"><small>Page generated on Sat, 09 Jul 2016 12:15:51 +0000</small></p>
    Powered by <a href="http://www.yiiframework.com/" rel="external">Yii Framework</a></footer>

<script type="text/javascript">jQuery(document).ready(function () {
    var shiftWindow = function () { scrollBy(0, -50) };
    if (location.hash) setTimeout(shiftWindow, 1);
    window.addEventListener("hashchange", shiftWindow);
var element = document.createElement("script");
element.src = "./jssearch.index.js";
document.body.appendChild(element);

var searchBox = $('#searchbox');

// search when typing in search field
searchBox.on("keyup", function(event) {
    var query = $(this).val();

    if (query == '' || event.which == 27) {
        $('#search-resultbox').hide();
        return;
    } else if (event.which == 13) {
        var selectedLink = $('#search-resultbox a.selected');
        if (selectedLink.length != 0) {
            document.location = selectedLink.attr('href');
            return;
        }
    } else if (event.which == 38 || event.which == 40) {
        $('#search-resultbox').show();

        var selected = $('#search-resultbox a.selected');
        if (selected.length == 0) {
            $('#search-results').find('a').first().addClass('selected');
        } else {
            var next;
            if (event.which == 40) {
                next = selected.parent().next().find('a').first();
            } else {
                next = selected.parent().prev().find('a').first();
            }
            if (next.length != 0) {
                var resultbox = $('#search-results');
                var position = next.position();

//              TODO scrolling is buggy and jumps around
//                resultbox.scrollTop(Math.floor(position.top));
//                console.log(position.top);

                selected.removeClass('selected');
                next.addClass('selected');
            }
        }

        return;
    }
    $('#search-resultbox').show();
    $('#search-results').html('<li><span class="no-results">No results</span></li>');

    var result = jssearch.search(query);

    if (result.length > 0) {
        var i = 0;
        var resHtml = '';

        for (var key in result) {
            if (i++ > 20) {
                break;
            }
            resHtml = resHtml +
            '<li><a href="' + result[key].file.u.substr(3) +'"><span class="title">' + result[key].file.t + '</span>' +
            '<span class="description">' + result[key].file.d + '</span></a></li>';
        }
        $('#search-results').html(resHtml);
    }
});

// hide the search results on ESC
$(document).on("keyup", function(event) { if (event.which == 27) { $('#search-resultbox').hide(); } });
// hide search results on click to document
$(document).bind('click', function (e) { $('#search-resultbox').hide(); });
// except the following:
searchBox.bind('click', function(e) { e.stopPropagation(); });
$('#search-resultbox').bind('click', function(e) { e.stopPropagation(); });

});</script></body>
</html>
